Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bluetooth: Host: improve GATT documentation #86359

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

KyraLengfeld
Copy link
Collaborator

The gatt docs are very sparce, this commit adds imrpovements for the GATT server API part. Others will follow.

@zephyrbot zephyrbot added area: Bluetooth area: Bluetooth Host Bluetooth Host (excluding BR/EDR) labels Feb 26, 2025
@KyraLengfeld KyraLengfeld added the Trivial Changes that can be reviewed by anyone, i.e. doc changes, minor build system tweaks, etc. label Feb 26, 2025
@Thalley
Copy link
Collaborator

Thalley commented Feb 26, 2025

Great! Will do a proper review once it passes CI.

Did you use https://docs.zephyrproject.org/api-coverage/latest/zephyr/bluetooth/gatt.h.gcov.html to find the missing parts?

@KyraLengfeld
Copy link
Collaborator Author

KyraLengfeld commented Feb 26, 2025

Great! Will do a proper review once it passes CI.

Did you use https://docs.zephyrproject.org/api-coverage/latest/zephyr/bluetooth/gatt.h.gcov.html to find the missing parts?

Nope :) but we should probably use that once all our planned additions are in to double check. (We tried splitting our planned doc improvements into trivial chunks. So there will be a handful more small PRs coming anyway.)

jhedberg
jhedberg previously approved these changes Feb 26, 2025
Copy link
Collaborator

@Thalley Thalley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks OK; some non-blocking comments

The gatt docs are very sparce, this commit adds imrpovements for the
GATT server API part. Others will follow.

Signed-off-by: Kyra Lengfeld <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Bluetooth Host Bluetooth Host (excluding BR/EDR) area: Bluetooth Trivial Changes that can be reviewed by anyone, i.e. doc changes, minor build system tweaks, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants